The Delete document AS component

Insert button or link to delete the current document or another document.

When to use

This component is typically used when an editor should be able to delete a document directly from the Web page. 

Text

Specifies the text for the generated button or link.

Confirmation message

A confirmation message to be displayed to the caller prior to the actual delete.

CSS Class name

Specifies a CSS class to be applied to the generated link / button element.

Element to generate

• Link
  Create a regular link element
• Button
  Create an input element (type button)
• Advanced button
  Create an Html button
• Submit button
  Creates a submit button within a form element. When using this option the component cannot be included in a form element. Recommended when coding for accessibility.

Delete options

Delete root document

Specifies whether to delete the root document or not. This value has no meaning unless the document to delete is an include document.

Check for permission

Check the permission for the caller to determine if the user has access to delete. If this check fails, the component will not display anything.

Delete permanently

Indicates that the document should be deleted permanently rather that beeing thrown in the recycling bin. This will not work unless the caller has administrative permissions on the document or has the DestroyDocuments global right set.

Delete parent child relations

Indicates whether it is allowed to delete a document that has child documents or not. When this property is set the relation is broken between the document and its children thus breaking off the document hierarchy at this point. This parameter has meaning only if Delete permanently also is set.

Redirect options

Redirect document

Specifies a Content Studio document to redirect to after the delete operation.

Redirect presentation template

Specifies an optional presentation template to be applied to the document specified by the RedirectDocument parameter.

Advanced options

Document to delete

A document to delete. If not specified the current document is deleted or if Delete root is specified the root document. This value is mostly specified in a variable.